[heft] feat: add lifecycle events for Heft tasks + phases by aramissennyeydd · Pull Request #5250 · microsoft/rushstack

aramissennyeydd · 2025-06-11T16:51:25Z

Summary

Alternative to #5232 that exposes Operation lifecycle events directly instead of through a metrics interface.

Details

We're trying to measure the duration of specific Heft tasks similar to the duration of specific Rush phases. Specifically, I'm trying to understand the impact of migrating from Webpack to Rspack beyond manual benchmarking. This also opens up visibility into sync/blocking tasks and how to improve Heft parallelism.

How it was tested

Added new project that verified that output had the correct information,

 ---- build started ---- 
[lifecycle:example-lifecycle-plugin] --- build started ---
[build:clean] Deleted 0 files and 5 folders
[lifecycle:example-lifecycle-plugin] --- typescript started ---
[build:typescript] Using TypeScript version 5.8.2
[build:lint] Using ESLint version 8.57.0
[build:lint] Using TSLint version 5.20.1
[build:typescript] Copied 3 files and linked 0 files
[lifecycle:example-lifecycle-plugin] --- typescript finished in 1.25s ---
[lifecycle:example-lifecycle-plugin] --- lint started ---
[lifecycle:example-lifecycle-plugin] --- metadata-test started ---
[lifecycle:example-lifecycle-plugin] --- api-extractor started ---
[lifecycle:example-lifecycle-plugin] --- lint finished in 0.00s ---
[build:api-extractor] Using API Extractor version 7.52.8
[build:api-extractor] Analysis will use the bundled TypeScript version 5.8.2
[lifecycle:example-lifecycle-plugin] --- api-extractor finished in 0.61s ---
[lifecycle:example-lifecycle-plugin] --- metadata-test finished in 0.61s ---
 ---- build finished (1.878s) ---- 
-------------------- Finished (1.88s) --------------------

Impacted documentation

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

apps/heft/src/pluginFramework/HeftLifecycleSession.ts

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

common/reviews/api/heft.api.md

apps/heft/src/cli/HeftActionRunner.ts

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

libraries/operation-graph/src/OperationExecutionManager.ts

apps/heft/src/cli/HeftActionRunner.ts

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

dmichon-msft

This is definitely getting really close. It feels a lot cleaner now than the initial approach and gets us closer to being able to converge the runner stacks between Rush and Heft.

apps/heft/src/cli/HeftActionRunner.ts

libraries/operation-graph/src/OperationExecutionManager.ts

common/changes/@rushstack/operation-graph/sennyeya-heft-lifecycle_2025-06-11-16-53.json

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

aramissennyeydd · 2025-06-12T23:14:17Z

@dmichon-msft Should be ready for another round - basically updated the events to treat the phase operation more like a silent architectural node. It is no longer part of the input types to OperationExecutionManager, has no metadata, was already not being consumed by the beforeExecute/afterExecute hooks, but now gets explicitly skipped.

dmichon-msft

Little bit of cleanup left from old casts and type checks

apps/heft/src/cli/HeftActionRunner.ts

Co-authored-by: David Michon <dmichon@microsoft.com>

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

dmichon-msft

Just a minor nit left, otherwise looks good.

apps/heft/src/cli/HeftActionRunner.ts

Co-authored-by: David Michon <dmichon@microsoft.com>

aramissennyeydd · 2025-06-13T19:37:18Z

@dmichon-msft Updated 🙂

aramissennyeydd · 2025-06-20T18:40:15Z

@dmichon-msft Anything else that I need to do for this PR?

dmichon-msft · 2025-09-15T22:59:25Z

@aramissennyeydd , looking at this again since I'm doing some work on @rushstack/operation-graph; was it a deliberate choice to make these hooks Async or was that purely due to copying the existing hooks?

aramissennyeydd · 2025-09-17T15:02:08Z

@dmichon-msft I believe it was to copy the existing hooks, the plugin I wrote that uses this does all async work during recordMetrics or toolFinish.

feat: add lifecycle events for Heft operations

3798b73

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

aramissennyeydd requested a review from iclanton as a code owner June 11, 2025 16:51

github-project-automation bot added this to Bug Triage Jun 11, 2025

github-project-automation bot moved this to Needs triage in Bug Triage Jun 11, 2025

aramissennyeydd requested review from D4N14L, apostolisms, dmichon-msft, octogonz and patmill as code owners June 11, 2025 16:51

aramissennyeydd added 3 commits June 11, 2025 12:53

add changeset

c085eae

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

rename to be task or phase-specific

e25deab

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

update changeset

4721472

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

D4N14L reviewed Jun 11, 2025

View reviewed changes

apps/heft/src/pluginFramework/HeftLifecycleSession.ts Outdated Show resolved Hide resolved

aramissennyeydd added 3 commits June 11, 2025 14:13

fix readme

9a0bebf

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

add comments for hooks

d4b7dad

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

clean up

d05ddba

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

aramissennyeydd changed the title ~~[heft] feat: add lifecycle events for Heft operations~~ [heft] feat: add lifecycle events for Heft tasks + phases Jun 11, 2025

dmichon-msft reviewed Jun 11, 2025

View reviewed changes

common/reviews/api/heft.api.md Outdated Show resolved Hide resolved

common/reviews/api/heft.api.md Outdated Show resolved Hide resolved

apps/heft/src/cli/HeftActionRunner.ts Outdated Show resolved Hide resolved

aramissennyeydd added 4 commits June 11, 2025 16:34

use custom metadata instead of runner

1e908ae

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

export props to entry point

2b7d847

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

create interfaces for task + phase

7256849

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

ensure that metadata is populated

3cc0827

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

aramissennyeydd requested a review from dmichon-msft June 11, 2025 21:58

dmichon-msft reviewed Jun 11, 2025

View reviewed changes

libraries/operation-graph/src/OperationExecutionManager.ts Outdated Show resolved Hide resolved

apps/heft/src/cli/HeftActionRunner.ts Outdated Show resolved Hide resolved

apps/heft/src/cli/HeftActionRunner.ts Outdated Show resolved Hide resolved

aramissennyeydd added 4 commits June 12, 2025 09:09

remove operation on operationGroup events

61a220f

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

move operation grouping concern to caller

d7fb5b3

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

fix types

042eb33

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

fix imports

4c411eb

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

aramissennyeydd requested a review from dmichon-msft June 12, 2025 15:24

dmichon-msft reviewed Jun 12, 2025

View reviewed changes

aramissennyeydd added 2 commits June 12, 2025 18:58

don't consider phase nodes in the return type

a74cbc6

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

don't report on silent operations

21e500d

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

dmichon-msft reviewed Jun 13, 2025

View reviewed changes

apps/heft/src/cli/HeftActionRunner.ts Outdated Show resolved Hide resolved

apps/heft/src/cli/HeftActionRunner.ts Outdated Show resolved Hide resolved

apps/heft/src/cli/HeftActionRunner.ts Outdated Show resolved Hide resolved

aramissennyeydd and others added 3 commits June 12, 2025 22:02

Apply suggestions from code review

84deae1

Co-authored-by: David Michon <dmichon@microsoft.com>

simplify

dd975be

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

only get groups once

7b26e66

Signed-off-by: Aramis Sennyey <aramissennyeydd@users.noreply.github.com>

aramissennyeydd requested a review from dmichon-msft June 13, 2025 02:32

aramissennyeydd mentioned this pull request Jun 13, 2025

[heft] feat: add new task-level timing metrics #5232

Closed

dmichon-msft approved these changes Jun 13, 2025

View reviewed changes

apps/heft/src/cli/HeftActionRunner.ts Outdated Show resolved Hide resolved

Update apps/heft/src/cli/HeftActionRunner.ts

57a191b

Co-authored-by: David Michon <dmichon@microsoft.com>

iclanton moved this from Needs triage to In Progress in Bug Triage Jun 18, 2025

dmichon-msft approved these changes Jun 20, 2025

View reviewed changes

dmichon-msft merged commit df5971f into microsoft:main Jun 20, 2025
5 checks passed

github-project-automation bot moved this from In Progress to Closed in Bug Triage Jun 20, 2025

aramissennyeydd deleted the sennyeya/heft-lifecycle branch June 23, 2025 15:31

This was referenced Sep 17, 2025

[heft] heft watch mode always logs the re-run requestor task as unknown #4467

Closed

[heft] Require a logging name for every operation (followup) #4953

Closed

Conversation

aramissennyeydd commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Details

How it was tested

Impacted documentation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dmichon-msft left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aramissennyeydd commented Jun 12, 2025

Uh oh!

dmichon-msft left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dmichon-msft left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aramissennyeydd commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aramissennyeydd commented Jun 20, 2025

Uh oh!

Uh oh!

dmichon-msft commented Sep 15, 2025

Uh oh!

aramissennyeydd commented Sep 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aramissennyeydd commented Jun 11, 2025 •

edited

Loading

aramissennyeydd commented Jun 13, 2025 •

edited

Loading